home *** CD-ROM | disk | FTP | other *** search
/ Stone Design / Stone Design.iso / Stone_Friends / NeXT-Icons / next-icon@gun.com / Apps / mail-notifier / mail-notifier2.rtfd / .notify next >
Encoding:
Text File  |  1994-03-09  |  7.9 KB  |  217 lines
  1. #! /bin/sh
  2. #######################################################
  3. # INTRODUCTION    (.notify was written by gbrown@alumni.caltech.edu  )
  4. #        ( and is in the public domain.  Tabs every 4 spaces)
  5. # 
  6. # This script plays a user-specified sound when mail is received.
  7. # The user can specify not to play sounds when
  8. #        * he is not logged in on the console.
  9. #         * the mail is from a mailing list or uninteresting person
  10. # Sounds play even when the user is not logged in, if desired.
  11. # The user can specify an additional sound to play when the word 'urgent' 
  12. #        appears in first 40 lines of the message (assuming the message isn't 
  13. #        from a mailing list or unintersting person in the kill list)
  14. # 
  15. # This script can also be used to control the 'vacation' program, allowing 
  16. #    the user to specify a list of people NOT to notify when the user is 
  17. #    on vacation.  It is a matter of courtesy to add mailing list to this
  18. #    list, since the people in the list don't care if you are on vacation.
  19. #######################################################
  20.  
  21. #######################################################
  22. # INSTALLATION
  23. # (0) 'chmod 707 <this file>', so that it is executable and not writable.
  24. # (1) Put this script somewhere permanent.
  25. # (2) Turn on the public sound server in "Preferences.app".  You will
  26. #    only hear sounds if the user logged in has his public sound server on.
  27. #    If you want to hear sounds when noone is logged on, root must have his
  28. #    public sound server turned on.
  29. # (3) You should customize the variables below, following the instructions.
  30. # (4) execute the following line, appropriately modified 
  31. #    echo '\<yourUsername>,"|<theCompletePathnameOfThisFile>"' > ~/.forward
  32. #         where <yourUsername> is your username and 
  33. #         <theCompletePathnameOfThisFile> is the complete
  34. #         pathname of this file.
  35. #######################################################
  36.  
  37. #######################################################
  38. # CUSTOMIZATION
  39. #     Change the variables below to reflect the
  40. # desired settings at your site.
  41. #######################################################
  42. username=gbrown
  43.     # your username
  44.     # Example: username=gbrown
  45.  
  46. mailSound=~gbrown/Library/Sounds/Glenn.snd
  47.     # the sound to play when mail arrives
  48.     # Example: mailSound=~gbrown/Library/Sounds/Glenn.snd
  49.     
  50. urgentSound=~gbrown/Library/Sounds/Urgent.snd
  51.     # an extra sound to play if mail is has the word 'urgent' in it
  52.     # Example: urgentSound=~gbrown/Library/Sounds/Urgent.snd
  53.  
  54. silentSenders="next-icon@ RTFusers@ omniweb-l@"
  55.     # senders whose mail will not generate sounds.  This
  56.     # is a good place to list mailing lists.  Case
  57.     # is unimporatant in this list.
  58.     # Example: silentSenders="next-icon@ RTFusers@ omniweb-l@"
  59.  
  60. playOnlyWhenOnConsole=YES
  61.     # if you only want sounds played when you are logged onto
  62.     # the console, this variable should be YES.  Otherwise, set
  63.     # it to anything else.
  64.     # Example: playOnlyWhenOnConsole=YES
  65.  
  66. onVacation=NO
  67.     # Edit your ~/.vacation.msg, run 'vacation -I' in your home directory,
  68.     # and set onVacation to YES (in that order) when you go on vacation.
  69.     # Set it to anything else when you return from vacation.
  70.     # 'man vacation' for more info, but DO NOT modify the .forward file
  71.     # as the man page says.  This script handles the forwarding itself.
  72.     # Example: onVacation=NO
  73.  
  74. dontTellOnVacation=${silentSenders}
  75.     # a space delimited list of senders you don't want to send vacation
  76.     # messages to.  Mailing lists are good should be
  77.     # listed here.  Case is unimporant here. Use $silentSenders if
  78.     # you want this list to be the same as the silentSenders list.
  79.     # Example: dontTellOnVacation=$silentSenders
  80.     # Example: dontTellOnVacation="next-icon@ RTFusers@ omniweb-l jerk@netcom.com"
  81.  
  82. buff=/tmp/.notify.$username.buff
  83. senders=/tmp/.notify.$username.senders
  84. ifonconsole=/tmp/.notify.$username.ifonconsole
  85.     # The above 3 variables should specify three files
  86.     # that this script can create. They should be in a
  87.     # directory that $username can write to.  If the files
  88.     # exist, they must be owned by $username and
  89.     # will be destroyed.
  90.     # Example: buff=/tmp/.notify.username.buff
  91.     #           senders=/tmp/.notify.$username.senders
  92.     #           ifonconsole=/tmp/.notify.$username.ifonconsole
  93.  
  94.     
  95. #######################################################
  96. # CODE
  97. #    Do not modify any code below this point unless you
  98. # really know what you are doing.
  99. #######################################################
  100.  
  101. ##########################
  102. # STARTUP CODE
  103. ##########################
  104.  
  105. homeDir=~$username    #the user's home directory
  106. # if the ifonconsole script is not installed,
  107. # install a copy if needed.
  108. #echo p=$playOnlyWhenOnConsole.
  109. if test ${playOnlyWhenOnConsole-YES} = YES # if we need the script
  110. then     
  111.     #echo checking if installed.
  112.     # if the $ifonconsole script is not installed, install it.
  113.     if test \! -f $ifonconsole && $ifonconsole $username /bin/false /bin/false
  114.     then
  115.         #echo installing
  116.         echo '#! /bin/sh'\                                                    >  $ifonconsole
  117.         echo '# This script has the syntax'\                                >> $ifonconsole
  118.         echo '#ifonconsole username oncommand [offcommand]'\                >> $ifonconsole
  119.         echo '# oncommand is executed if username is logged into the'\        >> $ifonconsole
  120.         echo '# console.  offcommand is run if not.  You should put '\        >> $ifonconsole
  121.         echo '# single quotes around the oncommand and offcommand in csh'\    >> $ifonconsole
  122.         echo '# or sh to make them single arguments.  The commands'\        >> $ifonconsole
  123.         echo '# are executed using sh.'\                                    >> $ifonconsole
  124.         echo 'if (who | fgrep console) | fgrep "$1" > /dev/null 2>&1;'\        >> $ifonconsole
  125.         echo 'then    '\                                                        >> $ifonconsole
  126.         echo '    ($2)'\                                                        >> $ifonconsole
  127.         echo 'else    '\                                                        >> $ifonconsole
  128.         echo '    ($3)'\                                                        >> $ifonconsole
  129.         echo 'fi    '\                                                        >> $ifonconsole
  130.         echo 'exit 0'\                                                        >> $ifonconsole
  131.         chmod a-w $ifonconsole        #make sure noone can change this file
  132.                                     #since we will execute it
  133.         chmod +x $ifonconsole        #make the file executable
  134.     fi
  135. fi
  136.  
  137. # copy the first screenful of the mail message to the buffer
  138. # for later perusal.
  139. head -40 > $buff
  140.  
  141. # put the lines that specify the sender into a file.
  142. # the To: and CC: lines are included because so messages to a mailing
  143. # list can also be detected.
  144. grep -i '^To:' $buff > $senders
  145. grep -i '^CC:' $buff >> $senders
  146. grep -i '^From:' $buff >> $senders
  147. #(echo; cat $buff) | grep -i '^From' >> $senders
  148. # From: can be on the first line causing the ^ to not match, so put a ^ at the beginning of
  149. # the file.
  150.  
  151. ##########################
  152. # SOUND PLAYING CODE
  153. ##########################
  154.  
  155. # Test for conditions that make us not want to play a sound
  156. for string in $silentSenders
  157. do
  158.     #echo \"$string\"
  159.     if grep -is $string < $senders 
  160.     then PLAYSOUND=NO; break; fi
  161. done
  162.  
  163. # Play the notification sound unless sound turned off above
  164. if test ${PLAYSOUND-YES} = YES
  165. then
  166.     if test ${playOnlyWhenOnConsole-YES} = YES
  167.     then
  168.         /usr/local/bin/ifonconsole gbrown /usr/bin/sndplay\ $mailSound
  169.     else
  170.         /usr/bin/sndplay $mailSound
  171.     fi
  172.     # See if the message is urgent and play sound if it is
  173.     if grep -i 'urgent' < $buff
  174.     then 
  175.         #echo The message is urgent.
  176.         if test ${playOnlyWhenOnConsole-YES} = YES
  177.         then
  178.             /usr/local/bin/ifonconsole gbrown /usr/bin/sndplay\ $urgentSound
  179.         else
  180.             /usr/bin/sndplay $urgentSound
  181.         fi
  182.     fi
  183. fi
  184.  
  185. ##########################
  186. # VACATION CODE
  187. ##########################
  188.  
  189. #echo entering vacation code
  190. if test ${onVacation-NO} = YES
  191. then
  192.     # Test for conditions that make us not want to play a sound and exit if such
  193.     # conditions are found.
  194.     for string in $dontTellOnVacation
  195.     do
  196.         #echo $string
  197.         # Don't make sounds if next-icon@ is in the 'To:' or 'CC:' line.
  198.         if grep -is $string < $buff 
  199.         then TELLONVACATION=NO; break; fi
  200.     done
  201.     
  202.     if test ${TELLONVACATION-YES} = YES
  203.     then
  204.         #echo going to homedir
  205.         #cd $homeDir
  206.         #echo calling vacation program
  207.         /usr/ucb/vacation $username < $buff
  208.     fi
  209. fi
  210.  
  211. ##########################
  212. # CLEANUP CODE
  213. ##########################
  214. rm $buff $senders
  215. exit 0
  216.  
  217. # This file is free, in the public domain, and offered without any warrantee whatsoever.